<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.UDisks2.Manager: UDisks Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="UDisks Reference Manual">
<link rel="up" href="ch02.html" title="D-Bus Interfaces">
<link rel="prev" href="ch02.html" title="D-Bus Interfaces">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.Drive.html" title="org.freedesktop.UDisks2.Drive">
<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.Manager.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.Manager.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch02.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.Drive.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gdbus-org.freedesktop.UDisks2.Manager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-Manager.top_of_page"></a>org.freedesktop.UDisks2.Manager</span></h2>
<p>org.freedesktop.UDisks2.Manager — Manager singleton</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.CanFormat" title="The CanFormat() method">CanFormat</a>       (IN  s     type,
                 OUT (bs)  available);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.CanResize" title="The CanResize() method">CanResize</a>       (IN  s     type,
                 OUT (bts) available);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.CanCheck" title="The CanCheck() method">CanCheck</a>        (IN  s     type,
                 OUT (bs)  available);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.CanRepair" title="The CanRepair() method">CanRepair</a>       (IN  s     type,
                 OUT (bs)  available);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.LoopSetup" title="The LoopSetup() method">LoopSetup</a>       (IN  h     fd,
                 IN  a{sv} options,
                 OUT o     resulting_device);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.MDRaidCreate" title="The MDRaidCreate() method">MDRaidCreate</a>    (IN  ao    blocks,
                 IN  s     level,
                 IN  s     name,
                 IN  t     chunk,
                 IN  a{sv} options,
                 OUT o     resulting_array);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.EnableModules" title="The EnableModules() method">EnableModules</a>   (IN  b     enable);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.GetBlockDevices" title="The GetBlockDevices() method">GetBlockDevices</a> (IN  a{sv} options,
                 OUT ao    block_objects);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-method-org-freedesktop-UDisks2-Manager.ResolveDevice" title="The ResolveDevice() method">ResolveDevice</a>   (IN  a{sv} devspec,
                 IN  a{sv} options,
                 OUT ao    devices);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.2.4"></a><h2>Properties</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-property-org-freedesktop-UDisks2-Manager.Version" title='The "Version" property'>Version</a>                   readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-property-org-freedesktop-UDisks2-Manager.SupportedFilesystems" title='The "SupportedFilesystems" property'>SupportedFilesystems</a>      readable   as
<a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-property-org-freedesktop-UDisks2-Manager.SupportedEncryptionTypes" title='The "SupportedEncryptionTypes" property'>SupportedEncryptionTypes</a>  readable   as
<a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-property-org-freedesktop-UDisks2-Manager.DefaultEncryptionType" title='The "DefaultEncryptionType" property'>DefaultEncryptionType</a>     readable   s
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-Manager"></a><h2>Description</h2>
<p>      Interface for top-level manager singleton object located at the
      object path <code class="literal">/org/freedesktop/UDisks2/Manager</code>.
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.Manager"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Manager.CanFormat"></a><h3>The CanFormat() method</h3>
<pre class="programlisting">
CanFormat (IN  s    type,
           OUT (bs) available);
</pre>
<p>        Tests for availability to create the given filesystem.
        See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Manager.html#gdbus-property-org-freedesktop-UDisks2-Manager.SupportedFilesystems" title='The "SupportedFilesystems" property'>"SupportedFilesystems"</a> property
        for a list of known types. Unknown or unsupported filesystems result in an error.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
<td><p>The filesystem type to be tested for formatting availability.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT (bs) <em class="parameter"><code>available</code></em></code>:</span></p></td>
<td><p>Formatting availability and the required binary name if missing (i.e. no error and returns FALSE).</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Manager.CanResize"></a><h3>The CanResize() method</h3>
<pre class="programlisting">
CanResize (IN  s     type,
           OUT (bts) available);
</pre>
<p>        Tests for availability to resize the given filesystem.
        The mode flags indicate if growing and/or shriking resize is available if mounted/unmounted.
        The mode corresponds to bitwise-OR combined BDFsResizeFlags of the libblockdev FS plugin:
        BD_FS_OFFLINE_SHRINK = 2, shrinking resize allowed when unmounted
        BD_FS_OFFLINE_GROW = 4, growing resize allowed when unmounted
        BD_FS_ONLINE_SHRINK = 8, shrinking resize allowed when mounted
        BD_FS_ONLINE_GROW = 16, growing resize allowed when mounted
        Unknown filesystems or filesystems which do not support resizing result in errors.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
<td><p>The filesystem type to be tested for resize availability.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT (bts) <em class="parameter"><code>available</code></em></code>:</span></p></td>
<td><p>Resizing availability, flags for allowed resizing (i.e. growing/shrinking support for online/offline) and the required binary name if missing (i.e. no error and returns FALSE).</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Manager.CanCheck"></a><h3>The CanCheck() method</h3>
<pre class="programlisting">
CanCheck (IN  s    type,
          OUT (bs) available);
</pre>
<p>        Tests for availability to check the given filesystem.
        Unsupported filesystems or filesystems which do not support checking result in errors.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
<td><p>The filesystem type to be tested for consistency check availability.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT (bs) <em class="parameter"><code>available</code></em></code>:</span></p></td>
<td><p>Checking availability and the required binary name if missing (i.e. no error and returns FALSE).</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Manager.CanRepair"></a><h3>The CanRepair() method</h3>
<pre class="programlisting">
CanRepair (IN  s    type,
           OUT (bs) available);
</pre>
<p>        Tests for availability repair the given filesystem.
        Unsupported filesystems or filesystems which do not support repairing result in errors.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
<td><p>The filesystem type to be tested for repair availability.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT (bs) <em class="parameter"><code>available</code></em></code>:</span></p></td>
<td><p>Repair availability and the required binary name if missing (i.e. no error and returns FALSE).</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Manager.LoopSetup"></a><h3>The LoopSetup() method</h3>
<pre class="programlisting">
LoopSetup (IN  h     fd,
           IN  a{sv} options,
           OUT o     resulting_device);
</pre>
<p>        Creates a block device for the file represented by <em class="parameter"><code>fd</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN h <em class="parameter"><code>fd</code></em></code>:</span></p></td>
<td><p>An index for the file descriptor to use.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) includes <em class="parameter"><code>offset</code></em> (of type 't'), <em class="parameter"><code>size</code></em> (of type 't'), <em class="parameter"><code>read-only</code></em> (of type 'b') and <em class="parameter"><code>no-part-scan</code></em> (of type 'b').</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>resulting_device</code></em></code>:</span></p></td>
<td><p>An object path to the object implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> interface.</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Manager.MDRaidCreate"></a><h3>The MDRaidCreate() method</h3>
<pre class="programlisting">
MDRaidCreate (IN  ao    blocks,
              IN  s     level,
              IN  s     name,
              IN  t     chunk,
              IN  a{sv} options,
              OUT o     resulting_array);
</pre>
<p>        Creates a new RAID array on the block devices specified by
        <em class="parameter"><code>blocks</code></em>. Each element in this array must be an object path to
        an object implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a>
        interface.
</p>
<p>        Known and supported values for <em class="parameter"><code>level</code></em> include
        <span class="quote">“<span class="quote">raid0</span>”</span>, <span class="quote">“<span class="quote">raid1</span>”</span>,
        <span class="quote">“<span class="quote">raid4</span>”</span>, <span class="quote">“<span class="quote">raid5</span>”</span>,
        <span class="quote">“<span class="quote">raid6</span>”</span> and <span class="quote">“<span class="quote">raid10</span>”</span>.
</p>
<p>        Before the array is created, all devices in <em class="parameter"><code>blocks</code></em> are
        erased. Once created (but before the method returns), the RAID
        array will be erased.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN ao <em class="parameter"><code>blocks</code></em></code>:</span></p></td>
<td><p>An array of object paths to objects implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> interface.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>level</code></em></code>:</span></p></td>
<td><p>The RAID level for the array.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
<td><p>The name for the array.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>chunk</code></em></code>:</span></p></td>
<td><p>The chunk size (in bytes) or 0 if <em class="parameter"><code>level</code></em> is <span class="quote">“<span class="quote">raid1</span>”</span>.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>resulting_array</code></em></code>:</span></p></td>
<td><p>An object path to the object implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.MDRaid.html#gdbus-interface-org-freedesktop-UDisks2-MDRaid.top_of_page">org.freedesktop.UDisks2.MDRaid</a> interface.</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.0.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Manager.EnableModules"></a><h3>The EnableModules() method</h3>
<pre class="programlisting">
EnableModules (IN  b enable);
</pre>
<p>        Loads and activates modules. This action also causes all objects to receive "add" uevent that triggers additional module interfaces activation.
</p>
<p>        Modules cannot be deactivated for the moment. Any consecutive calls with modules already enabled equals to noop.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>enable</code></em></code>:</span></p></td>
<td><p>A boolean value indicating whether modules should be enabled. Currently only the <code class="constant">TRUE</code> value is permitted.</p></td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Manager.GetBlockDevices"></a><h3>The GetBlockDevices() method</h3>
<pre class="programlisting">
GetBlockDevices (IN  a{sv} options,
                 OUT ao    block_objects);
</pre>
<p>        Get list of all block devices (object paths of objects implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a> interface) known to UDisks.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT ao <em class="parameter"><code>block_objects</code></em></code>:</span></p></td>
<td><p></p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7.2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Manager.ResolveDevice"></a><h3>The ResolveDevice() method</h3>
<pre class="programlisting">
ResolveDevice (IN  a{sv} devspec,
               IN  a{sv} options,
               OUT ao    devices);
</pre>
<p>        Get device(s) matching specification given in <em class="parameter"><code>devspec</code></em>.
</p>
<p>        Currently supported keys for <em class="parameter"><code>devspec</code></em> include:
        </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">path (type <code class="literal">'s'</code>)</span></p></td>
<td><p>
              Device path (e.g. <span class="quote">“<span class="quote">/dev/sda</span>”</span>). This also includes symlinks in <span class="quote">“<span class="quote">/dev</span>”</span>
              (both <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Device" title='The "Device" property'>"Device"</a> and <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.Symlinks" title='The "Symlinks" property'>"Symlinks"</a> are used).
            </p></td>
</tr>
<tr>
<td><p><span class="term">label (type <code class="literal">'s'</code>)</span></p></td>
<td><p>
              Filesystem label. <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdLabel" title='The "IdLabel" property'>"IdLabel"</a> is used.
            </p></td>
</tr>
<tr>
<td><p><span class="term">uuid (type <code class="literal">'s'</code>)</span></p></td>
<td><p>
              Filesystem UUID. <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-property-org-freedesktop-UDisks2-Block.IdUUID" title='The "IdUUID" property'>"IdUUID"</a> is used.
            </p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
<p>        It is possbile to specify multiple keys. In this case, only devices matching all values will be returned.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>devspec</code></em></code>:</span></p></td>
<td><p>Dictionary with specification of a device.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT ao <em class="parameter"><code>devices</code></em></code>:</span></p></td>
<td><p>List of object paths of all devices matching <em class="parameter"><code>devspec</code></em>.</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.7.3</p>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.Manager"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Manager.Version"></a><h3>The "Version" property</h3>
<pre class="programlisting">
Version  readable   s
</pre>
<p>The version of the daemon currently running</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Manager.SupportedFilesystems"></a><h3>The "SupportedFilesystems" property</h3>
<pre class="programlisting">
SupportedFilesystems  readable   as
</pre>
<p>List of supported filesystem by UDisks2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Manager.SupportedEncryptionTypes"></a><h3>The "SupportedEncryptionTypes" property</h3>
<pre class="programlisting">
SupportedEncryptionTypes  readable   as
</pre>
<p>List of supported encryption types by UDisks2</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Manager.DefaultEncryptionType"></a><h3>The "DefaultEncryptionType" property</h3>
<pre class="programlisting">
DefaultEncryptionType  readable   s
</pre>
<p></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29</div>
</body>
</html>